<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Voodoo Shader Framework: VoodooShader::FullscreenManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespace_voodoo_shader.html">VoodooShader</a>::<a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html">FullscreenManager</a>
  </div>
</div>
<div class="contents">
<h1>VoodooShader::FullscreenManager Class Reference</h1><!-- doxytag: class="VoodooShader::FullscreenManager" -->
<p>Manager class to simplify loading and unloading fullscreen (post-processing) shader effects.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_fullscreen_manager_8hpp_source.html">FullscreenManager.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for VoodooShader::FullscreenManager:</div>
<div class="dynsection">
<div class="center"><img src="class_voodoo_shader_1_1_fullscreen_manager__coll__graph.png" border="0" usemap="#_voodoo_shader_1_1_fullscreen_manager_coll__map" alt="Collaboration graph"/></div>
<map name="_voodoo_shader_1_1_fullscreen_manager_coll__map" id="_voodoo_shader_1_1_fullscreen_manager_coll__map">
<area shape="rect" id="node2" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework." alt="" coords="215,101,356,131"/><area shape="rect" id="node4" href="class_voodoo_shader_1_1_material_manager.html" title="Manager class to simplify loading and using material (texture&#45;bound) shaders." alt="" coords="180,309,391,339"/><area shape="rect" id="node6" href="class_voodoo_shader_1_1_shader.html" title="VoodooShader::Shader" alt="" coords="208,197,363,227"/><area shape="rect" id="node10" href="class_voodoo_shader_1_1_adapter.html" title="Graphics adapter class, responsible for interfacing the Voodoo Core with a given..." alt="" coords="253,5,413,35"/><area shape="rect" id="node12" href="class_voodoo_shader_1_1_logger.html" title="Logfile management class, capable of opening, closing, writing to and dumping log..." alt="" coords="437,5,592,35"/><area shape="rect" id="node14" href="class_voodoo_shader_1_1_formatter.html" title="Logging Format class." alt="" coords="465,101,636,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_voodoo_shader_1_1_fullscreen_manager-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#aeca0ef1675db981c48eff64754133e70">Add</a> (<a class="el" href="class_voodoo_shader_1_1_shader.html">Shader</a> *shader, int position=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Insert a shader into the render queue.  <a href="#aeca0ef1675db981c48eff64754133e70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#aad3d9cc7d699c24f4007037576d2e142">FullscreenManager</a> (<a class="el" href="class_voodoo_shader_1_1_core.html">Core</a> *parent)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#aad3d9cc7d699c24f4007037576d2e142"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#af21c4671d947b202867ee05a625b4f26">Remove</a> (size_t position)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a shader from the render queue.  <a href="#af21c4671d947b202867ee05a625b4f26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#af0c2a455c75b1c15b4fe826278d6b6be">Render</a> (unsigned int start=0, int count=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Binds shaders from the post-processing queue and draws them to screen.  <a href="#af0c2a455c75b1c15b4fe826278d6b6be"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_voodoo_shader_1_1_core.html">Core</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#a1c9c62ade60d15aa0c086b4d45e698a4">mParent</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A constant reference to the parent <a class="el" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework.">VoodooShader::Core</a>.  <a href="#a1c9c62ade60d15aa0c086b4d45e698a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_voodoo_shader.html#a2672eafa2dc32ea0782af912ef2feccd">ShaderVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#a041e88f50af158ae938aab437b2e8079">mShaders</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A vector containing the list of shaders to render, in order.  <a href="#a041e88f50af158ae938aab437b2e8079"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Manager class to simplify loading and unloading fullscreen (post-processing) shader effects. </p>
<p>This object provides complete control and support for a multi-shader, multi-pass render chain. It provides functions for inserting and removing <a class="el" href="class_voodoo_shader_1_1_shader.html">Shader</a> shaders. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aad3d9cc7d699c24f4007037576d2e142"></a><!-- doxytag: member="VoodooShader::FullscreenManager::FullscreenManager" ref="aad3d9cc7d699c24f4007037576d2e142" args="(Core *parent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">VoodooShader::FullscreenManager::FullscreenManager </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_voodoo_shader_1_1_core.html">Core</a> *&nbsp;</td>
          <td class="paramname"> <em>parent</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default constructor. </p>
<p>Requires a <a class="el" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework.">VoodooShader::Core</a> parent object. This must only be called by the Core::Create function, as having multiple fullscreen managers is not supported and may lead to resource leaks.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The <a class="el" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework.">Core</a> to use as the parent. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeca0ef1675db981c48eff64754133e70"></a><!-- doxytag: member="VoodooShader::FullscreenManager::Add" ref="aeca0ef1675db981c48eff64754133e70" args="(Shader *shader, int position=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t VoodooShader::FullscreenManager::Add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_voodoo_shader_1_1_shader.html">Shader</a> *&nbsp;</td>
          <td class="paramname"> <em>shader</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>position</em> = <code>-1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Insert a shader into the render queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>shader</em>&nbsp;</td><td>The shader object to be inserted. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>The position at which to insert the shader. -1 indicates the end of the queue (akin to a push), 0 the beginning. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the shader in the queue. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_voodoo_shader_1_1_exception.html" title="Core engine class for the Voodoo Shader Framework.">Exception</a></em>&nbsp;</td><td>if position is less than -1 or greater than the end of the queue. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af21c4671d947b202867ee05a625b4f26"></a><!-- doxytag: member="VoodooShader::FullscreenManager::Remove" ref="af21c4671d947b202867ee05a625b4f26" args="(size_t position)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VoodooShader::FullscreenManager::Remove </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>position</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Removes a shader from the render queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>The position of the shader to be removed. -1 indicates the end of the queue (aking to pop), 0 the beginning. </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_voodoo_shader_1_1_exception.html" title="Core engine class for the Voodoo Shader Framework.">Exception</a></em>&nbsp;</td><td>if position is less than -1 or greater than the end of the queue. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af0c2a455c75b1c15b4fe826278d6b6be"></a><!-- doxytag: member="VoodooShader::FullscreenManager::Render" ref="af0c2a455c75b1c15b4fe826278d6b6be" args="(unsigned int start=0, int count=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VoodooShader::FullscreenManager::Render </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>start</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>count</em> = <code>-1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Binds shaders from the post-processing queue and draws them to screen. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>start</em>&nbsp;</td><td>The first shader to be drawn (0-based index). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>The number of shaders to draw (-1 for all from start to the end of the queue). </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_voodoo_shader_1_1_exception.html" title="Core engine class for the Voodoo Shader Framework.">Exception</a></em>&nbsp;</td><td>if start is past the end of the queue. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_voodoo_shader_1_1_exception.html" title="Core engine class for the Voodoo Shader Framework.">Exception</a></em>&nbsp;</td><td>if count is 0. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="class_voodoo_shader_1_1_exception.html" title="Core engine class for the Voodoo Shader Framework.">Exception</a></em>&nbsp;</td><td>if the parent <a class="el" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework.">Core</a> has no <a class="el" href="class_voodoo_shader_1_1_adapter.html" title="Graphics adapter class, responsible for interfacing the Voodoo Core with a given...">Adapter</a> set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1c9c62ade60d15aa0c086b4d45e698a4"></a><!-- doxytag: member="VoodooShader::FullscreenManager::mParent" ref="a1c9c62ade60d15aa0c086b4d45e698a4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_voodoo_shader_1_1_core.html">Core</a>* <a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#a1c9c62ade60d15aa0c086b4d45e698a4">VoodooShader::FullscreenManager::mParent</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A constant reference to the parent <a class="el" href="class_voodoo_shader_1_1_core.html" title="Core engine class for the Voodoo Shader Framework.">VoodooShader::Core</a>. </p>

</div>
</div>
<a class="anchor" id="a041e88f50af158ae938aab437b2e8079"></a><!-- doxytag: member="VoodooShader::FullscreenManager::mShaders" ref="a041e88f50af158ae938aab437b2e8079" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_voodoo_shader.html#a2672eafa2dc32ea0782af912ef2feccd">ShaderVector</a> <a class="el" href="class_voodoo_shader_1_1_fullscreen_manager.html#a041e88f50af158ae938aab437b2e8079">VoodooShader::FullscreenManager::mShaders</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A vector containing the list of shaders to render, in order. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>K:/VoodooShader/Framework/<a class="el" href="_fullscreen_manager_8hpp_source.html">FullscreenManager.hpp</a></li>
<li>K:/VoodooShader/Framework/<a class="el" href="_fullscreen_manager_8cpp.html">FullscreenManager.cpp</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Oct 14 23:19:05 2010 for Voodoo Shader Framework by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
